Azure Maps Weather Service (stable:1.1)

2025/07/24 • 17 updated methods

Weather_GetHourlyForecast (updated)
Description :  The `Get Hourly Forecast` API is an HTTP `GET` that Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index. For more information, see [Request hourly weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-hourly-weather-forecast-data). If you are using the Gen1 S0 pricing tier, you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). If you are using Gen1 S1 or Gen2 pricing tier, you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetHourlyForecast",
  "$responses": {
    "200": {
      "$properties": {
        "forecasts": {
          "$properties": [
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            },
            {
              "temperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "realFeelTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wetBulbTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "dewPoint": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wind": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "windGust": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "visibility": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "ceiling": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "totalLiquid": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "rain": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "snow": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "ice": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/forecast/hourly/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are * `1` - Return forecast data for the next hour. Default value. * `12` - Return hourly forecast for next 12 hours. * `24` - Return hourly forecast for next 24 hours. * `72` - Return hourly forecast for next 72 hours (3 days). * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
forecasts:
{
Description: Forecast data for each returned hour. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the weather icon. ,
Required: False ,
}
string ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
isDaylight:
{
Description: Specifies whether or not it is daylight. True indicates day light. ,
Required: False ,
}
boolean ,
temperature:
{
Description: Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wetBulbTemperature:
{
Description: The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ceiling:
{
Description: Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
uvIndex:
{
Description: Measure of the strength of the ultraviolet radiation from the sun. Supported values are: * `0-2` - Low danger from the sun's UV rays or the average person. * `3-5` - Moderate risk of harm from unprotected sun exposure. * `6-7` - High risk of harm from unprotected sun exposure. * `8-10` - Very high risk of harm from unprotected sun exposure. * `11+` - Extreme risk of harm from unprotected sun exposure. ,
Format: int32 ,
Required: False ,
}
integer ,
uvIndexPhrase:
{
Description: Phrase associated with the `uvIndex`. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '50'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '50'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of snow. For example, '5'. ,
Format: int32 ,
Required: False ,
}
integer ,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetMinuteForecast (updated)
Description :  The `Get Minute Forecast` API is an HTTP `GET` request that returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in intervals of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ). For more information, see [Request minute-by-minute weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-minute-by-minute-weather-forecast-data).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetMinuteForecast",
  "$responses": {
    "200": {
      "$properties": {
        "summary": [
          {
            "#name": "iconCode",
            "Description": {
              "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
              "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
            }
          }
        ],
        "intervalSummaries": {
          "$properties": [
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            }
          ]
        },
        "intervals": {
          "$properties": [
            {
              "#name": "threshold",
              "Description": {
                "new": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dBZ is zero, not present in the response.",
                "old": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response."
              }
            },
            {
              "#name": "color",
              "Description": {
                "new": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dBZ is zero, color is not present in the response.",
                "old": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response."
              }
            },
            {
              "#name": "simplifiedColor",
              "Description": {
                "new": "The band color that maps to the precipitation type and threshold. If dBZ is zero, not present in the response.",
                "old": "The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response."
              }
            },
            {
              "#name": "precipitationType",
              "Description": {
                "new": "Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.",
                "old": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response."
              },
              "Enum": {
                "new": [
                  [
                    "Ice",
                    "Ice"
                  ],
                  [
                    "Mix",
                    "Mix"
                  ],
                  [
                    "Rain",
                    "Rain"
                  ],
                  [
                    "Snow",
                    "Snow"
                  ]
                ],
                "old": [
                  [
                    "Rain",
                    "Rain"
                  ],
                  [
                    "Snow",
                    "Snow"
                  ],
                  [
                    "Ice",
                    "Ice"
                  ],
                  [
                    "Mix",
                    "Mix"
                  ]
                ]
              }
            },
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/forecast/minute/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
interval:
{
Description: Specifies time interval in minutes for the returned weather forecast. Supported values are * `1` - Retrieve forecast for 1-minute intervals. Returned by default. * `5` - Retrieve forecasts for 5-minute intervals. * `15` - Retrieve forecasts for 15-minute intervals. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Phrase summaries for the entire forecast period. ,
Required: False ,
}
{
briefPhrase60:
{
Description: Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters. ,
Required: False ,
}
string ,
briefPhrase:
{
Description: Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Long summary phrase for the next 120 minutes. Phrase length is 60+ characters. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
intervalSummaries:
{
Description: Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops. ,
Required: False ,
}
[
{
startMinute:
{
Description: The first minute to which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
endMinute:
{
Description: The last minute to which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutes:
{
Description: The number of minutes for which the summary applies. ,
Format: int32 ,
Required: False ,
}
integer ,
shortPhrase:
{
Description: Short summary phrase. Phrase length is approximately 25 characters. ,
Required: False ,
}
string ,
briefPhrase:
{
Description: Brief summary phrase. Phrase length is approximately 60 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Long summary phrase. Phrase length is 60+ characters. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
intervals:
{
Description: Forecast data for each interval in the forecast. ,
Required: False ,
}
[
{
startTime:
{
Description: The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
minute:
{
Description: The first minute for the interval. ,
Format: int32 ,
Required: False ,
}
integer ,
dbz:
{
Description: A unit that represents forecasted precipitation intensity. ,
Format: double ,
Required: False ,
}
number ,
shortPhrase:
{
Description: A short phrase describing precipitation condition for the interval. ,
Required: False ,
}
string ,
threshold:
{
Description: Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dBZ is zero, not present in the response. ,
Required: False ,
}
string ,
color:
{
Description: The full spectrum color that maps to the dBZ (decibel relative to Z). If dBZ is zero, color is not present in the response. ,
Required: False ,
}
{
red:
{
Description: Red component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
green:
{
Description: Green component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
blue:
{
Description: Blue component of the RGB value ,
Format: int32 ,
Required: False ,
}
integer ,
hex:
{
Description: Hexadecimal color value. ,
Required: False ,
}
string ,
}
,
simplifiedColor:
{
Description: The band color that maps to the precipitation type and threshold. If dBZ is zero, not present in the response. ,
Required: False ,
}
{
red:
{
Description: Red component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
green:
{
Description: Green component of the RGB value. ,
Format: int32 ,
Required: False ,
}
integer ,
blue:
{
Description: Blue component of the RGB value ,
Format: int32 ,
Required: False ,
}
integer ,
hex:
{
Description: Hexadecimal color value. ,
Required: False ,
}
string ,
}
,
precipitationType:
{
Description: Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero. ,
Enum:
{
Ice: Ice ,
Mix: Mix ,
Rain: Rain ,
Snow: Snow ,
}
,
Required: False ,
}
enum ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetQuarterDayForecast (updated)
Description :  The `Get Quarter-Day Forecast` API is an HTTP `GET` request that returns a detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetQuarterDayForecast",
  "$responses": {
    "200": {
      "$properties": {
        "forecasts": {
          "$properties": [
            {
              "#name": "quarter",
              "Description": {
                "new": "Divides the day into four 6-hour quarters. Valid values are 0-3:
  • 0: Morning (7am - 1pm)
  • 1: Afternoon (1pm - 7pm)
  • 2: Evening (7pm - 1am)
  • 3: Overnight (1am - 7am)
",
                "old": "Quarter of the day."
              }
            },
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            },
            {
              "temperature": [
                {
                  "minimum": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "maximum": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "realFeelTemperature": [
                {
                  "minimum": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "maximum": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "dewPoint": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wind": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "windGust": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "visibility": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "#name": "precipitationType",
              "Description": {
                "new": "Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.",
                "old": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response."
              },
              "Enum": {
                "new": [
                  [
                    "Ice",
                    "Ice"
                  ],
                  [
                    "Mix",
                    "Mix"
                  ],
                  [
                    "Rain",
                    "Rain"
                  ],
                  [
                    "Snow",
                    "Snow"
                  ]
                ],
                "old": [
                  [
                    "Rain",
                    "Rain"
                  ],
                  [
                    "Snow",
                    "Snow"
                  ],
                  [
                    "Ice",
                    "Ice"
                  ],
                  [
                    "Mix",
                    "Mix"
                  ]
                ]
              }
            },
            {
              "totalLiquid": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "rain": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "snow": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "ice": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/forecast/quarterDay/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Specifies for how many days the quester-day forecast responses are returned. Supported values are: * `1` - Return forecast data for the next day. Returned by default. * `5` - Return forecast data for the next 5 days. * `10` - Return forecast data for next 10 days. * `15` - Return forecast data for the next 15 days. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
forecasts:
{
Description: Forecast data for each quarter in the response. ,
Required: False ,
}
[
{
date:
{
Description: Date of the forecast as example, 2019-10-27T00:00:00 ,
Format: date-time ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
quarter:
{
Description: Divides the day into four 6-hour quarters. Valid values are 0-3:
  • 0: Morning (7am - 1pm)
  • 1: Afternoon (1pm - 7pm)
  • 2: Evening (7pm - 1am)
  • 3: Overnight (1am - 7am)
 ,
Format: int32 ,
Required: False ,
}
integer ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
phrase:
{
Description: Short summary phrase summary for quarter. ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values for the quarter. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature values for the quarter. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero. ,
Enum:
{
Ice: Ice ,
Mix: Mix ,
Rain: Rain ,
Snow: Snow ,
}
,
Required: False ,
}
enum ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '10'. ,
Format: int32 ,
Required: False ,
}
integer ,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetCurrentConditions (updated)
Description :  The `Get Current Conditions` API is an HTTP `GET` request that returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with The response includes details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. For more information, see [Request real-time weather data](/azure/azure-maps/how-to-request-weather-data#request-real-time-weather-data)
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetCurrentConditions",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            },
            {
              "temperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "realFeelTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "realFeelTemperatureShade": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "dewPoint": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wind": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "windGust": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "visibility": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "ceiling": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "pressure": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "pastTwentyFourHourTemperatureDeparture": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "apparentTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "windChillTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wetBulbTemperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "precipitationSummary": [
                {
                  "pastHour": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past3Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past6Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past9Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past12Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past18Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                },
                {
                  "past24Hours": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "temperatureSummary": [
                {
                  "past6Hours": [
                    {
                      "minimum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    },
                    {
                      "maximum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    }
                  ]
                },
                {
                  "past12Hours": [
                    {
                      "minimum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    },
                    {
                      "maximum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    }
                  ]
                },
                {
                  "past24Hours": [
                    {
                      "minimum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    },
                    {
                      "maximum": [
                        {
                          "#name": "unitType",
                          "Description": {
                            "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                            "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/currentConditions/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
details:
{
Description: Return full details for the current conditions. Available values are * `true` - Returns full details. By default all details are returned. * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature. ,
Required: False ,
}
string ,
duration:
{
Description: Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: * `0` - Return the most current weather conditions. * `6` - Return weather conditions from past 6 hours. * `24` - Return weather conditions from past 24 hours. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: Detailed current weather conditions. ,
Required: False ,
}
[
{
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
phrase:
{
Description: Phrase description of the current weather condition. Displayed in specified language. ,
Required: False ,
}
string ,
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
isDayTime:
{
Description: Indicates the time of the day. True indicates 'day',', false indicates 'night. ,
Required: False ,
}
boolean ,
temperature:
{
Description: Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
realFeelTemperatureShade:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
relativeHumidity:
{
Description: Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature. ,
Format: int32 ,
Required: False ,
}
integer ,
dewPoint:
{
Description: The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
uvIndex:
{
Description: Measure of the strength of the ultraviolet radiation from the sun. Supported values are: * `0-2` - Low danger from the sun's UV rays or the average person. * `3-5` - Moderate risk of harm from unprotected sun exposure. * `6-7` - High risk of harm from unprotected sun exposure. * `8-10` - Very high risk of harm from unprotected sun exposure. * `11+` - Extreme risk of harm from unprotected sun exposure. ,
Format: int32 ,
Required: False ,
}
integer ,
uvIndexPhrase:
{
Description: Phrase associated with the `uvIndex`. ,
Required: False ,
}
string ,
visibility:
{
Description: Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
obstructionsToVisibility:
{
Description: Cause of limited visibility. Possible values: - _A = heavy thunderstorm/hail_ - _BD = blowing dust_ - _BN = blowing sand_ - _BS = blowing snow_ - _D = dust_ - _F = fog_ - _GF = ground fog_ - _HZ = haze_ - _I = ice_ - _IC = ice crystals_ - _IF = ice fog_ - _IP = ice pellets_ - _IPW = ice pellets shower_ - _K = smoke_ - _L = drizzle_ - _R = rain_ - _RS = rain/snow_ - _RW = rain shower_ - _S = snow_ - _SG = snow granules_ - _SP = snow pellets_ - _SW = snow shower_ - _T = thunderstorm_ - _UP = undefined precipitation_ - _ZL = freezing drizzle_ - _ZR = freezing rain_ - _+ = heavy_ - _- = light_ ,
Required: False ,
}
string ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
ceiling:
{
Description: Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pressure:
{
Description: Atmospheric pressure in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
pressureTendency:
{
Description: Atmospheric pressure change. ,
Required: False ,
}
{
localizedDescription:
{
Description: Description of the pressure tendency in specified language ,
Required: False ,
}
string ,
code:
{
Description: Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising. ,
Required: False ,
}
string ,
}
,
pastTwentyFourHourTemperatureDeparture:
{
Description: Departure from the temperature observed 24 hours ago in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
apparentTemperature:
{
Description: Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
windChillTemperature:
{
Description: Perceived air temperature on exposed skin due to wind. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wetBulbTemperature:
{
Description: The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
precipitationSummary:
{
Description: Summary of precipitation amounts over the past 24 hours. ,
Required: False ,
}
{
pastHour:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past hour. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past3Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past three hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past6Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past9Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past nine hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past12Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past18Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
past24Hours:
{
Description: The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
temperatureSummary:
{
Description: Summary of temperature fluctuations over the past 6, 12, and 24 hours. ,
Required: False ,
}
{
past6Hours:
{
Description: Summary of temperature fluctuations over the past 6 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
past12Hours:
{
Description: Summary of temperature fluctuations over the past 12 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
past24Hours:
{
Description: Summary of temperature fluctuations over the past 24 hours. ,
Required: False ,
}
{
minimum:
{
Description: minimum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: maximum ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetDailyForecast (updated)
Description :  The `Get Daily Forecast` API is an HTTP `GET` request that returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response includes details such as temperature, wind, precipitation, air quality, and UV index. For more information, see [Request daily weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-daily-weather-forecast-data). If you are using the Gen1 S0 pricing tier, you can request daily forecast for the next 1, 5, 10, and 15 days. If you are using Gen1 S1 or Gen2 pricing tier, you can also request daily forecast for the next 25 days, and 45 days.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetDailyForecast",
  "$responses": {
    "200": {
      "$properties": {
        "forecasts": {
          "$properties": {
            "temperature": [
              {
                "minimum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "maximum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "realFeelTemperature": [
              {
                "minimum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "maximum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "realFeelTemperatureShade": [
              {
                "minimum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "maximum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "degreeDaySummary": [
              {
                "heating": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "cooling": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "day": [
              {
                "#name": "iconCode",
                "Description": {
                  "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                  "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
                }
              },
              {
                "#name": "precipitationType",
                "Description": {
                  "new": "Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.",
                  "old": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response."
                },
                "Enum": {
                  "new": [
                    [
                      "Ice",
                      "Ice"
                    ],
                    [
                      "Mix",
                      "Mix"
                    ],
                    [
                      "Rain",
                      "Rain"
                    ],
                    [
                      "Snow",
                      "Snow"
                    ]
                  ],
                  "old": [
                    [
                      "Rain",
                      "Rain"
                    ],
                    [
                      "Snow",
                      "Snow"
                    ],
                    [
                      "Ice",
                      "Ice"
                    ],
                    [
                      "Mix",
                      "Mix"
                    ]
                  ]
                }
              },
              {
                "wind": [
                  {
                    "speed": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "windGust": [
                  {
                    "speed": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "totalLiquid": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "rain": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "snow": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "ice": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "night": [
              {
                "#name": "iconCode",
                "Description": {
                  "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                  "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
                }
              },
              {
                "#name": "precipitationType",
                "Description": {
                  "new": "Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.",
                  "old": "Specifies the type of precipitation (\"Rain\" \"Snow\" \"Ice\" or \"Mix\"). If dbz is zero, precipitationType is not present in the response."
                },
                "Enum": {
                  "new": [
                    [
                      "Ice",
                      "Ice"
                    ],
                    [
                      "Mix",
                      "Mix"
                    ],
                    [
                      "Rain",
                      "Rain"
                    ],
                    [
                      "Snow",
                      "Snow"
                    ]
                  ],
                  "old": [
                    [
                      "Rain",
                      "Rain"
                    ],
                    [
                      "Snow",
                      "Snow"
                    ],
                    [
                      "Ice",
                      "Ice"
                    ],
                    [
                      "Mix",
                      "Mix"
                    ]
                  ]
                }
              },
              {
                "wind": [
                  {
                    "speed": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "windGust": [
                  {
                    "speed": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "totalLiquid": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "rain": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "snow": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "ice": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/forecast/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
duration:
{
Description: Specifies for how many days the daily forecast responses are returned. Available values are * `1` - Return forecast data for the next day. Returned by default. * `5` - Return forecast data for the next 5 days. * `10` - Return forecast data for the next 10 days. * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. * `45` - Return forecast data for the next 45 days. Only available in S1 SKU. ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period. ,
Required: False ,
}
{
startDate:
{
Description: Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
severity:
{
Description: severity ,
Format: int32 ,
Required: False ,
}
integer ,
phrase:
{
Description: Summary phrase of the daily forecast. Displayed in specified language. ,
Required: False ,
}
string ,
category:
{
Description: one or 2 word(s) to summarize the phrase. ,
Required: False ,
}
string ,
}
,
forecasts:
{
Description: Forecast data for each requested day. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values for the day. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperature:
{
Description: RealFeel™ Temperature being returned. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
realFeelTemperatureShade:
{
Description: RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade. ,
Required: False ,
}
{
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maximum:
{
Description: Maximum temperature for the time period ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
hoursOfSun:
{
Description: Hours of sun. ,
Format: float ,
Required: False ,
}
number ,
degreeDaySummary:
{
Description: Summary for mean temperature of Heating Degree Day or Cooling Degree Day information ,
Required: False ,
}
{
heating:
{
Description: Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cooling:
{
Description: Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
airAndPollen:
{
Description: Air quality ,
Required: False ,
}
[
{
name:
{
Description: Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index. ,
Required: False ,
}
string ,
value:
{
Description: Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless. ,
Format: int32 ,
Required: False ,
}
integer ,
category:
{
Description: Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous. ,
Required: False ,
}
string ,
categoryValue:
{
Description: Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Only exists for air quality. Examples include ozone and particle pollution. ,
Required: False ,
}
string ,
}
,
]
,
day:
{
Description: Day forecast detail ,
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
localSource:
{
Description: Local weather data provider information. ,
Required: False ,
}
{
id:
{
Description: Numeric identifier, unique to the local data provider. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided. ,
Required: False ,
}
string ,
weatherCode:
{
Description: Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons. ,
Required: False ,
}
string ,
}
,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero. ,
Enum:
{
Ice: Ice ,
Mix: Mix ,
Rain: Rain ,
Snow: Snow ,
}
,
Required: False ,
}
enum ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '80'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '40'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of ice. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hoursOfPrecipitation:
{
Description: Hours of precipitation ,
Format: float ,
Required: False ,
}
number ,
hoursOfRain:
{
Description: Hours of rain. ,
Format: float ,
Required: False ,
}
number ,
hoursOfSnow:
{
Description: Hours of snow. ,
Format: float ,
Required: False ,
}
number ,
hoursOfIce:
{
Description: Hours of ice. ,
Format: float ,
Required: False ,
}
number ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
night:
{
Description: Night forecast detail ,
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
iconPhrase:
{
Description: Phrase description of the icon. Displayed in specified language. For example, 'Sunny'. ,
Required: False ,
}
string ,
localSource:
{
Description: Local weather data provider information. ,
Required: False ,
}
{
id:
{
Description: Numeric identifier, unique to the local data provider. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided. ,
Required: False ,
}
string ,
weatherCode:
{
Description: Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons. ,
Required: False ,
}
string ,
}
,
hasPrecipitation:
{
Description: Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation. ,
Required: False ,
}
boolean ,
precipitationType:
{
Description: Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero. ,
Enum:
{
Ice: Ice ,
Mix: Mix ,
Rain: Rain ,
Snow: Snow ,
}
,
Required: False ,
}
enum ,
precipitationIntensity:
{
Description: Description of the intensity. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters. ,
Required: False ,
}
string ,
longPhrase:
{
Description: Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters. ,
Required: False ,
}
string ,
precipitationProbability:
{
Description: Percent representing the probability of precipitation. For example, '20'. ,
Format: int32 ,
Required: False ,
}
integer ,
thunderstormProbability:
{
Description: Percent representing the probability of a thunderstorm. For example, '80'. ,
Format: int32 ,
Required: False ,
}
integer ,
rainProbability:
{
Description: Percent representing the probability of rain. For example, '40'. ,
Format: int32 ,
Required: False ,
}
integer ,
snowProbability:
{
Description: Percent representing the probability of snow. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
iceProbability:
{
Description: Percent representing the probability of ice. For example, '30'. ,
Format: int32 ,
Required: False ,
}
integer ,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind gust. Wind gust is a sudden, brief increase in speed of the wind. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
totalLiquid:
{
Description: Total liquid equivalent of precipitation during the forecast period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rain:
{
Description: Rain ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snow:
{
Description: Snow ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ice:
{
Description: Ice ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hoursOfPrecipitation:
{
Description: Hours of precipitation ,
Format: float ,
Required: False ,
}
number ,
hoursOfRain:
{
Description: Hours of rain. ,
Format: float ,
Required: False ,
}
number ,
hoursOfSnow:
{
Description: Hours of snow. ,
Format: float ,
Required: False ,
}
number ,
hoursOfIce:
{
Description: Hours of ice. ,
Format: float ,
Required: False ,
}
number ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sources:
{
Description: Source(s) of the forecast data. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetWeatherAlongRoute (updated)
Description :  The `Get Weather Along Route` API is an HTTP `GET` request that returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint. In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint. The API covers all regions of the planet except latitudes above Greenland and Antarctica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetWeatherAlongRoute",
  "$responses": {
    "200": {
      "$properties": {
        "summary": [
          {
            "#name": "iconCode",
            "Description": {
              "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
              "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
            }
          },
          {
            "hazards": [
              {
                "#name": "maxHazardIndex",
                "Description": {
                  "new": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency.",
                  "old": "A severity/hazard index.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency."
                }
              },
              {
                "hazardDetails": {
                  "$properties": [
                    {
                      "#name": "hazardIndex",
                      "Description": {
                        "new": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency.",
                        "old": "A severity/hazard index.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency."
                      }
                    }
                  ]
                }
              }
            ]
          }
        ],
        "waypoints": {
          "$properties": [
            {
              "#name": "iconCode",
              "Description": {
                "new": "Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.",
                "old": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details."
              }
            },
            {
              "temperature": [
                {
                  "#name": "unitType",
                  "Description": {
                    "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                    "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                  }
                }
              ]
            },
            {
              "wind": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "windGust": [
                {
                  "speed": [
                    {
                      "#name": "unitType",
                      "Description": {
                        "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                        "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "hazards": [
                {
                  "#name": "maxHazardIndex",
                  "Description": {
                    "new": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency.",
                    "old": "A severity/hazard index.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency."
                  }
                },
                {
                  "hazardDetails": {
                    "$properties": [
                      {
                        "#name": "hazardIndex",
                        "Description": {
                          "new": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency.",
                          "old": "A severity/hazard index.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "notifications": {
                "$properties": [
                  {
                    "#name": "hazardIndex",
                    "Description": {
                      "new": "The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency.",
                      "old": "A severity/hazard index.\n  * `0` - No hazard.\n  * `1` - Be informed, be aware.\n  * `2` - Pay attention, be prepared.\n  * `3` - Take action.\n  * `4` - Life threatening, emergency."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/route/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where * `Latitude` - Latitude coordinate in decimal degrees. * `Longitude` - Longitude coordinate in decimal degrees. * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Short summary of the weather along the route. ,
Required: False ,
}
{
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
hazards:
{
Description: Description of the weather hazard affecting the trip. ,
Required: False ,
}
{
maxHazardIndex:
{
Description: The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardDetails:
{
Description: Details of the weather hazards affecting the trip. ,
Required: False ,
}
[
{
hazardIndex:
{
Description: The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
waypoints:
{
Description: Data for each waypoint returned in the same order as specified in the request. ,
Required: False ,
}
[
{
iconCode:
{
Description: Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL. ,
Format: int32 ,
Required: False ,
}
integer ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
isDayTime:
{
Description: Indicates the time of the day. True indicates 'day',', false indicates 'night. ,
Required: False ,
}
boolean ,
cloudCover:
{
Description: Percent representing cloud cover. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Description: Specific value of a given unit related to weather. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
wind:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
windGust:
{
Description: Wind details being returned including speed and direction. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
precipitation:
{
Description: Precipitation forecast of the weather along the route. ,
Required: False ,
}
{
dbz:
{
Description: The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0. ,
Format: double ,
Required: False ,
}
number ,
type:
{
Description: Precipitation type. If precipitation should occur, the type that it will be: "RAIN," "HAIL," "SNOW," "ICE," or "MIX." ,
Required: False ,
}
string ,
}
,
lightningCount:
{
Description: Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity. ,
Format: int32 ,
Required: False ,
}
integer ,
sunGlare:
{
Description: A rating that indicates how blinding the sun is for the driver. ,
Required: False ,
}
{
calculatedVehicleHeading:
{
Description: If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided. ,
Format: int32 ,
Required: False ,
}
integer ,
glareIndex:
{
Description: An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
hazards:
{
Description: Description of the weather hazard affecting the trip. ,
Required: False ,
}
{
maxHazardIndex:
{
Description: The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardDetails:
{
Description: Details of the weather hazards affecting the trip. ,
Required: False ,
}
[
{
hazardIndex:
{
Description: The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notifications:
{
Description: List of weather hazard notifications. ,
Required: False ,
}
[
{
type:
{
Description: A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard. ,
Required: False ,
}
string ,
hazardIndex:
{
Description: The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency. ,
Format: int32 ,
Required: False ,
}
integer ,
hazardCode:
{
Description: A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning. ,
Required: False ,
}
string ,
shortPhrase:
{
Description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetSevereWeatherAlerts (updated)
Description :  Severe weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products. The `Get Severe Weather Alerts` API is an HTTP `GET` request that returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires. For more information, see [Request severe weather alerts](/azure/azure-maps/how-to-request-weather-data#request-severe-weather-alerts)
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetSevereWeatherAlerts",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "alertAreas": {
              "$properties": {
                "latestStatus": [
                  {
                    "#name": "english",
                    "Enum": {
                      "new": [
                        [
                          "Cancel",
                          "Indicates that the alert has been canceled before its originally scheduled expiration time."
                        ],
                        [
                          "Continue",
                          "Indicates that the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`."
                        ],
                        [
                          "Correct",
                          "Indicates that the alert has been modified to correct a previous error."
                        ],
                        [
                          "Expire",
                          "Indicates that the alert has expired and is no longer active."
                        ],
                        [
                          "Extend",
                          "Indicates that the alert has been extended in duration, area, or both since its initial issuance."
                        ],
                        [
                          "New",
                          "The status of an alert when first issued."
                        ],
                        [
                          "Update",
                          "Indicates that the alert has been modified since its initial issuance."
                        ],
                        [
                          "Upgrade",
                          "Indicates that the alert has been elevated to a higher class or category since first issued."
                        ]
                      ],
                      "old": [
                        [
                          "New",
                          "\"New\" - the status of an alert upon initial issuance."
                        ],
                        [
                          "Extend",
                          "\"Extend\" - the alert has been extended in time, in area, or both since its initial issuance."
                        ],
                        [
                          "Cancel",
                          "\"Cancel\" - the alert has been canceled prior to its original expiration time."
                        ],
                        [
                          "Correct",
                          "\"Correct\" - the alert has been modified to correct a previous error."
                        ],
                        [
                          "Expire",
                          "\"Expire\" - the alert has expired and is no longer active."
                        ],
                        [
                          "Upgrade",
                          "\"Upgrade\" - the alert has been upgraded to a higher class or category since its initial issuance."
                        ],
                        [
                          "Continue",
                          "\"Continue\" - the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`."
                        ],
                        [
                          "Update",
                          "\"Update\" - the alert has been updated since its initial issuance."
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/severe/alerts/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
details:
{
Description: Return full details for the severe weather alerts. Available values are * `true` - Returns full details. By default all details are returned. * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: A list of all severe weather alerts for the queried location. ,
Required: False ,
}
[
{
countryCode:
{
Description: 2-character ISO 3166-1 Alpha-2 country code, for example, "US". ,
Required: False ,
}
string ,
alertId:
{
Description: A unique numerical identifier for a weather alert. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description of the alert. ,
Required: False ,
}
{
localized:
{
Description: Description of the alert in the specified language. By default English (en-US) is returned if the language parameter is not specified in the request. ,
Required: False ,
}
string ,
english:
{
Description: Description of the alert in English (en-US). ,
Required: False ,
}
string ,
}
,
category:
{
Description: Category of the alert. ,
Required: False ,
}
string ,
priority:
{
Description: Number signifying the importance or ranking order of the given alert within the country/region it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. The number varies by country/region and can change over time as each country/region evolves their alert systems. ,
Format: int32 ,
Required: False ,
}
integer ,
class:
{
Description: Classification of the alert. This field is not available for all countries and therefore not always returned. ,
Required: False ,
}
string ,
level:
{
Description: Severity level of the alert. This field is not available for all countries and therefore not always returned. ,
Required: False ,
}
string ,
source:
{
Description: The provider of the alert information. By default the source is returned in English (en-US). The alerts are from official Government Meteorological Agencies and leading global weather alert providers. ,
Required: False ,
}
string ,
sourceId:
{
Description: A numerical identifier associated with the source provider name of the alert data. ,
Format: int32 ,
Required: False ,
}
integer ,
disclaimer:
{
Description: A disclaimer regarding the source of the alert information. This field is not always available. For example, disclaimer may include details about the delays or potential issues related to the alarm. ,
Required: False ,
}
string ,
alertAreas:
{
Description: Information about the alert specific to the affected area(s). ,
Required: False ,
}
[
{
name:
{
Description: The name of an area which is affected by the alert. The location that was requested falls under the alert area. ,
Required: False ,
}
string ,
summary:
{
Description: Text summarizing the alert in the returned area. ,
Required: False ,
}
string ,
startTime:
{
Description: The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location. ,
Format: date-time ,
Required: False ,
}
string ,
latestStatus:
{
Description: The latest status of the alert in the current area. ,
Required: False ,
}
{
localized:
{
Description: The latest status keyword for the alert, in the specified language. By default, returned in English (en-US). ,
Required: False ,
}
string ,
english:
{
Description: Latest status keyword for the alert, in English (en-US). ,
Enum:
{
Cancel: Indicates that the alert has been canceled before its originally scheduled expiration time. ,
Continue: Indicates that the alert has been updated since its initial issuance, but no changes were made to `alertDetails`, `startTime`, `endTime`, or `class`. ,
Correct: Indicates that the alert has been modified to correct a previous error. ,
Expire: Indicates that the alert has expired and is no longer active. ,
Extend: Indicates that the alert has been extended in duration, area, or both since its initial issuance. ,
New: The status of an alert when first issued. ,
Update: Indicates that the alert has been modified since its initial issuance. ,
Upgrade: Indicates that the alert has been elevated to a higher class or category since first issued. ,
}
,
Required: False ,
}
enum ,
}
,
alertDetails:
{
Description: Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field. ,
Required: False ,
}
string ,
alertDetailsLanguageCode:
{
Description: Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetTropicalStormActive (updated)
Description :  The `Get Tropical Storm Active` API is an HTTP `GET` request that returns a list of all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetTropicalStormActive",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "basinId",
              "Enum": {
                "new": [
                  [
                    "AL",
                    "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms."
                  ],
                  [
                    "CP",
                    "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas."
                  ],
                  [
                    "EP",
                    "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin."
                  ],
                  [
                    "NI",
                    "**The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones."
                  ],
                  [
                    "NP",
                    "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally."
                  ],
                  [
                    "SI",
                    "**The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions."
                  ],
                  [
                    "SP",
                    "**The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands."
                  ]
                ],
                "old": [
                  [
                    "AL",
                    "Atlantic"
                  ],
                  [
                    "EP",
                    "Eastern Pacific"
                  ],
                  [
                    "SI",
                    "Southwest Indian Ocean"
                  ],
                  [
                    "NI",
                    "North Indian Ocean"
                  ],
                  [
                    "CP",
                    "Central Pacific"
                  ],
                  [
                    "NP",
                    "Northwest Pacific"
                  ],
                  [
                    "SP",
                    "South Pacific"
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/tropical/storms/active/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: All government-issued active storms ,
Required: False ,
}
[
{
year:
{
Description: Year of origination ,
Required: False ,
}
string ,
basinId:
{
Description: Basin identifier (AL, EP, SI, NI, CP, NP, SP) ,
Enum:
{
AL: **The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms. ,
CP: **The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas. ,
EP: **The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin. ,
NI: **The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones. ,
NP: **The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally. ,
SI: **The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions. ,
SP: **The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the depression. ,
Required: False ,
}
string ,
isActive:
{
Description: True if the depression has been updated recently. ,
Required: False ,
}
boolean ,
isSubtropical:
{
Description: True when the depression is classified as a subtropical cyclone. ,
Required: False ,
}
boolean ,
govId:
{
Description: Government storm ID. This will match the depression number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetTropicalStormSearch (updated)
Description :  The `Get Tropical Storm Search` API is an HTTP `GET` request that returns a list of government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetTropicalStormSearch",
  "$parameters": [
    {
      "#name": "basinId",
      "Description": {
        "new": "The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.",
        "old": "Basin identifier"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "basinId",
              "Enum": {
                "new": [
                  [
                    "AL",
                    "**The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms."
                  ],
                  [
                    "CP",
                    "**The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas."
                  ],
                  [
                    "EP",
                    "**The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin."
                  ],
                  [
                    "NI",
                    "**The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones."
                  ],
                  [
                    "NP",
                    "**The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally."
                  ],
                  [
                    "SI",
                    "**The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions."
                  ],
                  [
                    "SP",
                    "**The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands."
                  ]
                ],
                "old": [
                  [
                    "AL",
                    "Atlantic"
                  ],
                  [
                    "EP",
                    "Eastern Pacific"
                  ],
                  [
                    "SI",
                    "Southwest Indian Ocean"
                  ],
                  [
                    "NI",
                    "North Indian Ocean"
                  ],
                  [
                    "CP",
                    "Central Pacific"
                  ],
                  [
                    "NP",
                    "Northwest Pacific"
                  ],
                  [
                    "SP",
                    "South Pacific"
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/tropical/storms/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
year:
{
Description: Year of the cyclone(s) ,
Format: int32 ,
Required: True ,
}
integer ,
basinId:
{
Description: The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin. ,
Required: False ,
}
string ,
govId:
{
Description: Government storm Id ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
results:
{
Description: Search government-issued storms ,
Required: False ,
}
[
{
year:
{
Description: Year of origination ,
Required: False ,
}
string ,
basinId:
{
Description: Basin identifier (AL, EP, SI, NI, CP, NP, SP) ,
Enum:
{
AL: **The Atlantic Ocean**. Crucial for tracking hurricanes that affect the Americas and the Caribbean. It is one of the most active regions for tropical storms. ,
CP: **The Central Pacific Ocean**. This basin is used for storms affecting Hawaii and surrounding areas. ,
EP: **The Eastern Pacific Ocean**. This basin tracks storms impacting the western coast of the Americas, including Mexico and Central America. It is adjacent to the Central Pacific basin. ,
NI: **The North Indian Ocean**. This basin covers storms impacting South Asia, including countries like India and Bangladesh, which are frequently affected by cyclones. ,
NP: **The Northwest Pacific Ocean**. This basin is important for tracking typhoons that affect East Asia, including countries like China, Japan, and the Philippines. It is the most active tropical storm regions globally. ,
SI: **The South Indian Ocean**. This basin, positioned south of the equator, covers cyclones impacting Madagascar, Africa, and surrounding regions. ,
SP: **The South Pacific Ocean**. This basin, positioned south of the equator, is relevant for cyclones affecting Australia and the South Pacific islands. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the depression. ,
Required: False ,
}
string ,
isActive:
{
Description: True if the depression has been updated recently. ,
Required: False ,
}
boolean ,
isRetired:
{
Description: True if the storm name has been permanently retired in the source basin. ,
Required: False ,
}
boolean ,
isSubtropical:
{
Description: True when the depression is classified as a subtropical cyclone. ,
Required: False ,
}
boolean ,
govId:
{
Description: Government storm ID. This will match the depression number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetTropicalStormForecast (updated)
Description :  The `Get Tropical Storm Forecasts` API is an HTTP `GET` request that returns individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetTropicalStormForecast",
  "$parameters": [
    {
      "#name": "basinId",
      "Description": {
        "new": "The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.",
        "old": "Basin identifier"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "maxWindGust": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "sustainedWind": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "windRadiiSummary": {
              "$properties": {
                "windSpeed": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/tropical/storms/forecasts/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
year:
{
Description: Year of the cyclone(s) ,
Format: int32 ,
Required: True ,
}
integer ,
basinId:
{
Description: The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin. ,
Required: True ,
}
string ,
govId:
{
Description: Government storm Id ,
Format: int32 ,
Required: True ,
}
integer ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
details:
{
Description: When true, wind radii summary data is included in the response ,
Required: False ,
}
boolean ,
radiiGeometry:
{
Description: When true, wind radii summary data and geoJSON details are included in the response ,
Required: False ,
}
boolean ,
windowGeometry:
{
Description: When true, window geometry data (geoJSON) is included in the response ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
results:
{
Description: The list of Government-issued forecasts ,
Required: False ,
}
[
{
dateTime:
{
Description: Datetime the forecast is valid, displayed in ISO8601 format. ,
Required: False ,
}
string ,
initializedDateTime:
{
Description: Datetime the forecast was created, displayed in ISO8601 format. ,
Required: False ,
}
string ,
location:
{
Description: Coordinates of the storm ,
Required: False ,
}
{
latitude:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
maxWindGust:
{
Description: Maximum wind gust speed associated with the storm. May be NULL. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sustainedWind:
{
Description: Maximum sustained wind speed associated with the storm. May be NULL. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: Possible status values include:
  • Cyclonic storm
  • Deep depression
  • Depression
  • Extremely severe cyclonic storm
  • Hurricane category (1-5)
  • Intense tropical cyclone
  • Moderate tropical storm
  • Post-tropical cyclone
  • Potential tropical cyclone
  • Severe cyclonic storm
  • Severe tropical storm
  • Subtropical
  • Super cyclonic storm
  • Tropical cyclone
  • Tropical cyclone category (1-5)
  • Tropical depression
  • Tropical disturbance
  • Tropical storm
  • Typhoon
  • Very intense tropical cyclone
  • Very severe cyclonic storm
  • Very strong typhoon
  • Violent typhoon
 ,
Required: False ,
}
string ,
window:
{
Description: Contains information about the forecast window for the storm during the specified time period (not the entire cone). If windowGeometry=true in the request, this object will include geoJSON details for window geometry. ,
Required: False ,
}
{
left:
{
Description: Location of the point on the left side of the window at the time of the timeframe. ,
Required: False ,
}
{
latitude:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
right:
{
Description: Location of the point on the right side of the window at the end of the timeframe. ,
Required: False ,
}
{
latitude:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
beginDateTime:
{
Description: DateTime of the beginning of the window of movement, displayed in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: DateTime of the end of the window of movement, displayed in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
beginStatus:
{
Description: Storm status at the beginning of the window. ,
Required: False ,
}
string ,
endStatus:
{
Description: Storm status at the end of the window. ,
Required: False ,
}
string ,
geometry:
{
Description: Displayed when windowGeometry=true in request. GeoJSON object containing coordinates describing the window of movement during the specified timeframe. ,
Required: False ,
}
object ,
}
,
windRadiiSummary:
{
Description: Displayed when details=true or radiiGeometry=true in the request. ,
Required: False ,
}
[
{
dateTime:
{
Description: DateTime for which the wind radii summary data is valid, displayed in ISO8601 format. ,
Required: False ,
}
string ,
windSpeed:
{
Description: Wind speed associated with the radiusSectorData. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
radiusSectorData:
{
Description: Contains the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant. ,
Required: False ,
}
[
{
beginBearing:
{
Description: Bearing, in degrees, of the beginning of the quadrant. ,
Format: double ,
Required: False ,
}
number ,
endBearing:
{
Description: Bearing, in degrees, of the end of the quadrant. ,
Format: double ,
Required: False ,
}
number ,
range:
{
Description: The radius of the quadrant, in nautical miles. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
radiiGeometry:
{
Description: GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetTropicalStormLocations (updated)
Description :  The `Get Tropical Storm Locations` API is an HTTP `GET` request that returns the location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetTropicalStormLocations",
  "$parameters": [
    {
      "#name": "basinId",
      "Description": {
        "new": "The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.",
        "old": "Basin identifier"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "maxWindGust": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "sustainedWind": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "minimumPressure": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "movement": [
              {
                "speed": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "windRadiiSummary": {
              "$properties": {
                "windSpeed": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/tropical/storms/locations/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
year:
{
Description: Year of the cyclone(s) ,
Format: int32 ,
Required: True ,
}
integer ,
basinId:
{
Description: The `basinId` enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin. ,
Required: True ,
}
string ,
govId:
{
Description: Government storm Id ,
Format: int32 ,
Required: True ,
}
integer ,
details:
{
Description: When true, wind radii summary data is included in the response ,
Required: False ,
}
boolean ,
radiiGeometry:
{
Description: When true, wind radii summary data and geoJSON details are included in the response ,
Required: False ,
}
boolean ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
current:
{
Description: When true, return the current storm location ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
results:
{
Description: Locations for an individual government-issued storm ,
Required: False ,
}
[
{
dateTime:
{
Description: Datetime the forecast is valid, displayed in ISO8601 format. ,
Required: False ,
}
string ,
location:
{
Description: Coordinates of the storm ,
Required: False ,
}
{
latitude:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
maxWindGust:
{
Description: Maximum wind gust speed associated with the storm. May be NULL. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sustainedWind:
{
Description: Maximum sustained wind speed associated with the storm. May be NULL. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
minimumPressure:
{
Description: Minimum pressure associated with the storm. May be NULL. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
movement:
{
Description: The storm movement information. ,
Required: False ,
}
{
direction:
{
Description: Wind direction ,
Required: False ,
}
{
degrees:
{
Description: Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359. ,
Format: int32 ,
Required: False ,
}
integer ,
localizedDescription:
{
Description: Direction abbreviation in the specified language. ,
Required: False ,
}
string ,
}
,
speed:
{
Description: Speed of the wind in specified unit. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
status:
{
Description: Storm status, in English. ,
Required: False ,
}
string ,
isSubtropical:
{
Description: True when the depression is classified as a subtropical cyclone. ,
Required: False ,
}
boolean ,
hasTropicalPotential:
{
Description: True when storm may develop into a Tropical System. ,
Required: False ,
}
boolean ,
isPostTropical:
{
Description: True when the storm is weakening away, and will no longer become a tropical system. ,
Required: False ,
}
boolean ,
windRadiiSummary:
{
Description: Displayed when details=true or radiiGeometry=true in the request. ,
Required: False ,
}
[
{
dateTime:
{
Description: DateTime for which the wind radii summary data is valid, displayed in ISO8601 format. ,
Required: False ,
}
string ,
windSpeed:
{
Description: Wind speed associated with the radiusSectorData. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
radiusSectorData:
{
Description: Contains the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant. ,
Required: False ,
}
[
{
beginBearing:
{
Description: Bearing, in degrees, of the beginning of the quadrant. ,
Format: double ,
Required: False ,
}
number ,
endBearing:
{
Description: Bearing, in degrees, of the end of the quadrant. ,
Format: double ,
Required: False ,
}
number ,
range:
{
Description: The radius of the quadrant, in nautical miles. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
radiiGeometry:
{
Description: GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetCurrentAirQuality (updated)
Description :  The `Get Current Air Quality` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status for current air quality, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetCurrentAirQuality",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "dominantPollutant",
              "Enum": {
                "new": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires."
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO)."
                  ],
                  [
                    "Ozone",
                    "Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants."
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets."
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes."
                  ]
                ],
                "old": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (\"CO\")"
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (\"NO2\")"
                  ],
                  [
                    "Ozone",
                    "Ozone (\"O3\")"
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (\"PM2.5\")"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (\"PM10\")"
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (\"SO2\")"
                  ]
                ]
              }
            },
            {
              "pollutants": {
                "$properties": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "CO",
                          "Carbon monoxide"
                        ],
                        [
                          "NO2",
                          "Nitrogen dioxide"
                        ],
                        [
                          "O3",
                          "Ozone"
                        ],
                        [
                          "PM2.5",
                          "Particulate matter 2.5"
                        ],
                        [
                          "PM10",
                          "Particulate matter 10"
                        ],
                        [
                          "SO2",
                          "Sulfur dioxide"
                        ]
                      ],
                      "old": [
                        [
                          "CO",
                          "Carbon monoxide (\"CO\")"
                        ],
                        [
                          "NO2",
                          "Nitrogen dioxide (\"NO2\")"
                        ],
                        [
                          "O3",
                          "Ozone (\"O3\")"
                        ],
                        [
                          "PM2.5",
                          "Particulate matter 2.5 (\"PM2.5\")"
                        ],
                        [
                          "PM10",
                          "Particulate matter 10 (\"PM10\")"
                        ],
                        [
                          "SO2",
                          "Sulfur dioxide (\"SO2\")"
                        ]
                      ]
                    }
                  },
                  {
                    "concentration": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/airQuality/current/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
pollutants:
{
Description: Boolean value that returns detailed information about each pollutant. By default is True. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
results:
{
Description: A list of all air quality results for the queried location. ,
Required: False ,
}
[
{
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
index:
{
Description: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information. ,
Format: float ,
Required: False ,
}
number ,
globalIndex:
{
Description: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality. ,
Format: float ,
Required: False ,
}
number ,
dominantPollutant:
{
Description: The pollutant with the highest concentration. ,
Enum:
{
Carbon Monoxide: Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires. ,
Nitrogen Dioxide: Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO). ,
Ozone: Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants. ,
Particulate Matter 2.5: Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods ,
Particulate Matter 10: Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets. ,
Sulfur Dioxide: Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: One-word description of the air quality in the requested language. For example, "Excellent". ,
Required: False ,
}
string ,
categoryColor:
{
Description: A unique color corresponding to the category of this air quality result. ,
Required: False ,
}
string ,
description:
{
Description: A textual explanation of this air quality result in the requested language. ,
Required: False ,
}
string ,
pollutants:
{
Description: Information about individual pollutants. ,
Required: False ,
}
[
{
type:
{
Description: Type of pollutant. Please note that more may be added at any time. ,
Enum:
{
CO: Carbon monoxide ,
NO2: Nitrogen dioxide ,
O3: Ozone ,
PM2.5: Particulate matter 2.5 ,
PM10: Particulate matter 10 ,
SO2: Sulfur dioxide ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the pollutant in English. ,
Required: False ,
}
string ,
index:
{
Description: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information. ,
Format: float ,
Required: False ,
}
number ,
globalIndex:
{
Description: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality. ,
Format: float ,
Required: False ,
}
number ,
concentration:
{
Description: An object containing the number of pollutant particles per volume of air. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetAirQualityDailyForecasts (updated)
Description :  The `Get Air Quality Daily Forecasts` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetAirQualityDailyForecasts",
  "$parameters": [
    {
      "#name": "duration",
      "Description": {
        "new": "Defines the duration for the air quality forecast, with options ranging from 1 to 7 days. The default duration is 1 day.",
        "old": "Specifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "dominantPollutant",
              "Enum": {
                "new": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires."
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO)."
                  ],
                  [
                    "Ozone",
                    "Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants."
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets."
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes."
                  ]
                ],
                "old": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (\"CO\")"
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (\"NO2\")"
                  ],
                  [
                    "Ozone",
                    "Ozone (\"O3\")"
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (\"PM2.5\")"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (\"PM10\")"
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (\"SO2\")"
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/airQuality/forecasts/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
duration:
{
Description: Defines the duration for the air quality forecast, with options ranging from 1 to 7 days. The default duration is 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
results:
{
Description: A list of all daily air quality forecasts for the queried location. ,
Required: False ,
}
[
{
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
index:
{
Description: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information. ,
Format: float ,
Required: False ,
}
number ,
globalIndex:
{
Description: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality. ,
Format: float ,
Required: False ,
}
number ,
dominantPollutant:
{
Description: The pollutant with the highest concentration. ,
Enum:
{
Carbon Monoxide: Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires. ,
Nitrogen Dioxide: Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO). ,
Ozone: Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants. ,
Particulate Matter 2.5: Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods ,
Particulate Matter 10: Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets. ,
Sulfur Dioxide: Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: One-word description of the air quality in the requested language. For example, "Excellent". ,
Required: False ,
}
string ,
categoryColor:
{
Description: A unique color corresponding to the category of this air quality result. ,
Required: False ,
}
string ,
description:
{
Description: A textual explanation of this air quality result in the requested language. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetAirQualityHourlyForecasts (updated)
Description :  The `Get Air Quality Hourly Forecasts` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetAirQualityHourlyForecasts",
  "$parameters": [
    {
      "#name": "duration",
      "Description": {
        "new": "Defines the duration, in hours, for the air quality forecast. Available values are 1, 12, 24, 48, 72, and 96. The default value is 1 hour.",
        "old": "Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": [
            {
              "#name": "dominantPollutant",
              "Enum": {
                "new": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires."
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO)."
                  ],
                  [
                    "Ozone",
                    "Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants."
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets."
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes."
                  ]
                ],
                "old": [
                  [
                    "Carbon Monoxide",
                    "Carbon monoxide (\"CO\")"
                  ],
                  [
                    "Nitrogen Dioxide",
                    "Nitrogen dioxide (\"NO2\")"
                  ],
                  [
                    "Ozone",
                    "Ozone (\"O3\")"
                  ],
                  [
                    "Particulate Matter 2.5",
                    "Particulate matter 2.5 (\"PM2.5\")"
                  ],
                  [
                    "Particulate Matter 10",
                    "Particulate matter 10 (\"PM10\")"
                  ],
                  [
                    "Sulfur Dioxide",
                    "Sulfur dioxide (\"SO2\")"
                  ]
                ]
              }
            },
            {
              "pollutants": {
                "$properties": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "CO",
                          "Carbon monoxide"
                        ],
                        [
                          "NO2",
                          "Nitrogen dioxide"
                        ],
                        [
                          "O3",
                          "Ozone"
                        ],
                        [
                          "PM2.5",
                          "Particulate matter 2.5"
                        ],
                        [
                          "PM10",
                          "Particulate matter 10"
                        ],
                        [
                          "SO2",
                          "Sulfur dioxide"
                        ]
                      ],
                      "old": [
                        [
                          "CO",
                          "Carbon monoxide (\"CO\")"
                        ],
                        [
                          "NO2",
                          "Nitrogen dioxide (\"NO2\")"
                        ],
                        [
                          "O3",
                          "Ozone (\"O3\")"
                        ],
                        [
                          "PM2.5",
                          "Particulate matter 2.5 (\"PM2.5\")"
                        ],
                        [
                          "PM10",
                          "Particulate matter 10 (\"PM10\")"
                        ],
                        [
                          "SO2",
                          "Sulfur dioxide (\"SO2\")"
                        ]
                      ]
                    }
                  },
                  {
                    "concentration": [
                      {
                        "#name": "unitType",
                        "Description": {
                          "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                          "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                        }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/airQuality/forecasts/hourly/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
duration:
{
Description: Defines the duration, in hours, for the air quality forecast. Available values are 1, 12, 24, 48, 72, and 96. The default value is 1 hour. ,
Format: int32 ,
Required: False ,
}
integer ,
pollutants:
{
Description: Boolean value that returns detailed information about each pollutant. By default is True. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
results:
{
Description: A list of all air quality results for the queried location. ,
Required: False ,
}
[
{
dateTime:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
index:
{
Description: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information. ,
Format: float ,
Required: False ,
}
number ,
globalIndex:
{
Description: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality. ,
Format: float ,
Required: False ,
}
number ,
dominantPollutant:
{
Description: The pollutant with the highest concentration. ,
Enum:
{
Carbon Monoxide: Carbon monoxide (CO) is a colorless, odorless, and tasteless but highly toxic gas produced by the incomplete combustion of carbon-containing fuels. Common sources include vehicle exhaust, gas stoves, furnaces, and wood fires. ,
Nitrogen Dioxide: Nitrogen dioxide (NO2) is a significant atmospheric pollutant. It is regulated and subject to recommended limit guidelines set by the World Health Organization (WHO). ,
Ozone: Ozone (O3) is a key component of photochemical smog, the brown, harmful haze that envelops many large cities, resulting from a photochemical reaction between sunlight and certain specific pollutants. ,
Particulate Matter 2.5: Particulate matter 2.5 (PM2.5) refers to fine particles with diameters that are generally 2.5 micrometers and smaller. These particles are more than 100 times thinner than a human hair and can remain suspended in the air for extended periods ,
Particulate Matter 10: Particulate matter 10 (PM10) refers to particles with diameters that are generally 10 micrometers and smaller. These particles can include dust, pollen, soot, smoke, and liquid droplets. ,
Sulfur Dioxide: Sulfur dioxide (SO2) is a heavy, colorless inorganic gas with a pungent, irritating odor. It is mainly produced by burning fossil fuels at power plants and industrial facilities, but it can also be emitted from natural sources such as volcanoes. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: One-word description of the air quality in the requested language. For example, "Excellent". ,
Required: False ,
}
string ,
categoryColor:
{
Description: A unique color corresponding to the category of this air quality result. ,
Required: False ,
}
string ,
description:
{
Description: A textual explanation of this air quality result in the requested language. ,
Required: False ,
}
string ,
pollutants:
{
Description: Information about individual pollutants. ,
Required: False ,
}
[
{
type:
{
Description: Type of pollutant. Please note that more may be added at any time. ,
Enum:
{
CO: Carbon monoxide ,
NO2: Nitrogen dioxide ,
O3: Ozone ,
PM2.5: Particulate matter 2.5 ,
PM10: Particulate matter 10 ,
SO2: Sulfur dioxide ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the pollutant in English. ,
Required: False ,
}
string ,
index:
{
Description: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information. ,
Format: float ,
Required: False ,
}
number ,
globalIndex:
{
Description: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality. ,
Format: float ,
Required: False ,
}
number ,
concentration:
{
Description: An object containing the number of pollutant particles per volume of air. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetDailyHistoricalActuals (updated)
Description :  The `Get Daily Historical Actuals` API is an HTTP `GET` request that returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetDailyHistoricalActuals",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "temperature": [
              {
                "maximum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "minimum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "average": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "degreeDaySummary": [
              {
                "heating": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "cooling": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "precipitation": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "snowfall": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ],
            "snowDepth": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/historical/actuals/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
startDate:
{
Description: Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
endDate:
{
Description: End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: Historical actuals for each requested day. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values. ,
Required: False ,
}
{
maximum:
{
Description: Maximum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
average:
{
Description: Average temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
degreeDaySummary:
{
Description: Summary of heating or cooling degree day information. Degree days are measures of how cold or warm a location is. A degree day compares the mean (the average of the high and low) outdoor temperatures recorded for a location to a standard temperature of 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
heating:
{
Description: Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cooling:
{
Description: Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
precipitation:
{
Description: The amount of precipitation (liquid equivalent) that has fallen. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snowfall:
{
Description: The amount of snow that has fallen. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
snowDepth:
{
Description: Snow depth. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetDailyHistoricalRecords (updated)
Description :  The `Get Daily Historical Records` API is an HTTP `GET` request that returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetDailyHistoricalRecords",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "temperature": [
              {
                "average": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/historical/records/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
startDate:
{
Description: Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
endDate:
{
Description: End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: Historical records for each requested day. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature value. ,
Required: False ,
}
{
maximum:
{
Description: Maximum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
year:
{
Description: Year the value occurred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
year:
{
Description: Year the value occurred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
average:
{
Description: Average temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
precipitation:
{
Description: Maximum amount of precipitation (liquid equivalent) that has fallen. ,
Required: False ,
}
{
maximum:
{
Description: Maximum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
year:
{
Description: Year the value occurred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
snowfall:
{
Description: Maximum snowfall. ,
Required: False ,
}
{
maximum:
{
Description: Maximum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
year:
{
Description: Year the value occurred. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Weather_GetDailyHistoricalNormals (updated)
Description :  The `Get Daily Historical Normals` API is an HTTP `GET` request that returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. The historical normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Weather_GetDailyHistoricalNormals",
  "$responses": {
    "200": {
      "$properties": {
        "results": {
          "$properties": {
            "temperature": [
              {
                "maximum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "minimum": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "average": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "degreeDaySummary": [
              {
                "heating": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              },
              {
                "cooling": [
                  {
                    "#name": "unitType",
                    "Description": {
                      "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                      "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                    }
                  }
                ]
              }
            ],
            "precipitation": [
              {
                "#name": "unitType",
                "Description": {
                  "new": "An integer representing the unit type.  For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).",
                  "old": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /weather/historical/normals/daily/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. ,
Required: True ,
}
array ,
startDate:
{
Description: Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
endDate:
{
Description: End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31). ,
Format: date ,
Required: True ,
}
string ,
unit:
{
Description: Specifies to return the data in either metric units or imperial units. Default value is metric. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
results:
{
Description: Historical normals for each requested day. ,
Required: False ,
}
[
{
date:
{
Description: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. ,
Format: date-time ,
Required: False ,
}
string ,
temperature:
{
Description: Temperature values. ,
Required: False ,
}
{
maximum:
{
Description: Maximum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
minimum:
{
Description: Minimum temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
average:
{
Description: Average temperature for the time period. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
degreeDaySummary:
{
Description: Summary of heating or cooling degree day information ,
Required: False ,
}
{
heating:
{
Description: Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
cooling:
{
Description: Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
precipitation:
{
Description: The amount of precipitation (liquid equivalent) that has fallen. ,
Required: False ,
}
{
value:
{
Description: Rounded value. ,
Format: float ,
Required: False ,
}
number ,
unit:
{
Description: Type of unit for the returned value. ,
Required: False ,
}
string ,
unitType:
{
Description: An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}